/*
 * libustream: User-space stackable streams
 * @(#) $Id: IUStreamFactory.h 2 2009-02-20 09:52:11Z mo@ilaven.net $
 */

/*
 * Copyright (c) 2002, 2008 Mo McRoberts.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The names of the author(s) of this software may not be used to endorse
 *    or promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
 * AUTHORS OF THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef USTREAM_IUSTREAMFACTORY_H_
# define USTREAM_IUSTREAMFACTORY_H_    1

# include <sys/types.h>

# include "com/com.h"
# include "iri.h"
# include "ustream/IUStreamNode.h"

/* IUStreamFactory is an alternative to IClassFactory used by libustream
 * to construct a node of a stream. The instance it constructs
 * will implement IUStreamNode.
 */

# undef INTERFACE
# define INTERFACE                     IUStreamFactory

DECLARE_INTERFACE_(IUStreamFactory, IUnknown)
{
	BEGIN_INTERFACE
	
	STDMETHOD(QueryInterface)(THIS_ com_riid_t riid, void **out) PURE;
	STDMETHOD_(uint32_t,AddRef)(THIS) PURE;
	STDMETHOD_(uint32_t,Release)(THIS) PURE;
	
	STDMETHOD(CreateStreamNode)(THIS_ com_rclsid_t clsid, IUStream *stream, IUStreamNode **out) PURE;
	STDMETHOD(CreateStreamHead)(THIS_ com_rclsid_t clsid, const iri_t *iri, int oflag, mode_t mode, IUStreamNode **out, int *fdout) PURE;
	END_INTERFACE
};

# if defined(COM_CINTERFACE) || !defined(__cplusplus)
#  define IUStreamFactory_QueryInterface(__this, riid, out) __this->lpVtbl->QueryInterface(__this, riid, out)
#  define IUStreamFactory_AddRef(__this) __this->lpVtbl->AddRef(__this)
#  define IUStreamFactory_Release(__this) __this->lpVtbl->Release(__this)
#  define IUStreamFactory_CreateStreamNode(__this, clsid, stream, out) __this->lpVtbl->CreateStreamNode(__this, clsid, stream, out)
#  define IUStreamFactory_CreateStreamHead(__this, clsid, iri, oflag, mode, out, fdout) __this->lpVtbl->CreateStreamHead(__this, clsid, iri, oflag, mode, out, fdout)
# endif

#endif /* !USTREAM_IUSTREAMFACTORY_H_ */

/* {7DCFF038-EC31-4FC1-B3F6-8A20C19CFC37} */
DEFINE_GUID(IID_IUStreamFactory, 0x7DCFF038, 0xEC31, 0x4FC1, 0xB3, 0xF6, 0x8A, 0x20, 0xC1, 0x9C, 0xFC, 0x37);
